home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 4 / Amiga Tools 4.iso / tools / internet-tools / connect-line / cl / devkit / docs / cl_prefs.doc < prev    next >
Encoding:
Text File  |  1995-09-01  |  3.4 KB  |  119 lines
  1. TABLE OF CONTENTS
  2.  
  3. cl_prefs.library/CLP_GetPrefs
  4. cl_prefs.library/CLP_GetPrefsSize
  5. cl_prefs.library/CLP_SetPrefs
  6. cl_prefs.library/CLP_GetPrefs                   cl_prefs.library/CLP_GetPrefs
  7.  
  8.    NAME   
  9.     CLP_GetPrefs -- Read one preference entry
  10.  
  11.    SYNOPSIS
  12.     RealSize = CLP_GetPrefs( PrefsID, SubID, Data, Datasize, Stamp )
  13.     D0                       D0       D1     A0    D2        A1
  14.  
  15.     ULONG CLP_GetPrefs( ULONG, APTR, ULONG, APTR );
  16.    
  17.    FUNCTION
  18.    This function reads one preference entry from the Connectline
  19.    preference database and copies a maximum of "Datasize"
  20.    Bytes to the destination data area.
  21.    
  22.     You may provide a secondary buffer to hold a comparision
  23.    stamp for CLP_SetPrefs(). This should generally be NULL
  24.     if you don't plan to write back the preference entry.
  25.    
  26.    INPUTS
  27.     PrefsID        The 4 Byte Preference ID
  28.    SubID        32 Bit SubID
  29.    Data        Pointer to your destination data area
  30.     Datasize    sizeof( Data )
  31.    Stamp        (optional) Pointer to your stamp data
  32.                area. May be NULL. If provided, must be
  33.                 sizeof( Data )
  34.    
  35.    RESULTS
  36.    RealSize    The real size of the preference entry
  37.    
  38.    NOTES
  39.    For TAGT_NOL, you must supply a pointer to a pointer
  40.    to a NOL, which will be filled in with a pointer to
  41.    a copy of the real NOL maintained by cl_prefs. You
  42.    *must* free this NOL yourself via CLU_NOL_Delete().
  43.    
  44.    SEE ALSO
  45.      CLP_SetPrefs(), CLP_GetPrefsSize(), clutil.library/CLU_NOL_Delete()
  46.    
  47.    BUGS
  48.    Before V16, TAGT_LONG didn't automatically set size to 4.
  49.  
  50. cl_prefs.library/CLP_GetPrefsSize           cl_prefs.library/CLP_GetPrefsSize
  51.  
  52.     NAME
  53.     CLP_GetPrefsSize -- Read size of preference entry
  54.  
  55.     SYNOPSIS
  56.     Size = CLP_GetPrefsSize( PrefsID, SubID )
  57.     D0                       D0       D1
  58.  
  59.     ULONG CLP_GetPrefsSize( ULONG, ULONG );
  60.  
  61.     FUNCTION
  62.     This routine returns the size of a preference entry with a
  63.     given ID.
  64.  
  65.     INPUTS
  66.     PrefsID        The 4 Byte Preference ID
  67.     SubID            32 Bit SubID
  68.  
  69.     RESULTS
  70.     Size        The size of the preference entry or 0 if no
  71.                 entry with the given ID exists
  72.  
  73.     NOTES
  74.     Returns 4 (sizeof(NOL)) for NOL entries.
  75.  
  76.     SEE ALSO
  77.     CLP_SetPrefs(), CLP_GetPrefs()
  78.  
  79.     BUGS
  80.  
  81. cl_prefs.library/CLP_SetPrefs                   cl_prefs.library/CLP_SetPrefs
  82.  
  83.    NAME   
  84.     CLP_SetPrefs -- Write a preference entry
  85.  
  86.    SYNOPSIS
  87.     error = CLP_SetPrefs( PrefsID, SubID, Data, Datasize, Stamp )
  88.     D0                    D0       D1     A0    D2        A1
  89.  
  90.     ULONG CLP_SetPrefs( ULONG, APTR, ULONG, APTR );
  91.    
  92.    FUNCTION
  93.    Set a preference entry. The data will be copied and can
  94.    be freed later (Note that this is also true for TAGT_NOL,
  95.    whereas a copy will be create via CLU_NOL_Clone())
  96.  
  97.    INPUTS
  98.     PrefsID        -- The 4 Byte Preference ID
  99.    SubID        -- 32 Bit SubID and Datatypes flags
  100.    Data        -- Pointer to your data area
  101.     Datasize    -- sizeof( Data )
  102.    Stamp        -- (optional) Pointer to your stamp data
  103.                   area. May be NULL. If provided, must be
  104.                    sizeof( Data )
  105.    
  106.    RESULTS
  107.    error -- 0 or error code.
  108.    
  109.    NOTES
  110.    For TAGT_NOL, you must supply a pointer to a pointer
  111.    to a NOL. This is for compatibility with CLP_GetPrefs().
  112.    
  113.    SEE ALSO
  114.      CLP_GetPrefs(), CLP_GetPrefsSize()
  115.    
  116.    BUGS
  117.    As of V16, stamps are not yet implemented.
  118.  
  119.